Window: Mention GtkHeaderBar in set_titlebar() doc
authorDaniel Boles <dboles@src.gnome.org>
Fri, 12 Jan 2018 21:26:36 +0000 (21:26 +0000)
committerDaniel Boles <dboles@src.gnome.org>
Fri, 12 Jan 2018 23:12:19 +0000 (23:12 +0000)
This is the typical thing passed here and what most users want, so we
should mention it here, rather than requiring users to figure it out.

gtk/gtkwindow.c

index d4bc48c2e158773770d61703dfa9b9b0e82283d5..c6aa5425ff648fabc0bbf45e1df78eb060cdb0a5 100644 (file)
@@ -4173,6 +4173,9 @@ on_titlebar_title_notify (GtkHeaderBar *titlebar,
  *
  * Sets a custom titlebar for @window.
  *
+ * A typical widget used here is #GtkHeaderBar, as it provides various features
+ * expected of a titlebar while allowing the addition of child widgets to it.
+ *
  * If you set a custom titlebar, GTK+ will do its best to convince
  * the window manager not to put its own titlebar on the window.
  * Depending on the system, this function may not work for a window